Version: 1.0.2

Add or Update Card Group

Add or Update Merchant Category Code (MCC) and country group of the issued card.

Method: POST

{{URL}}/cardv2

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameters	Description
reference Optional	String Unique reference ID of the request Sample Value: "visadps100053"
transactionType Mandatory	String Type of operation / transaction Constant Value : "UPDATE_CARD_GROUP"
customerId Mandatory	String Unique ID of the customer Sample Value : "100000000006001"
accountNumber Mandatory	String Account number of the customer Sample Value : "400320588344662"
product Mandatory	String Name of the product associated with the card Sample Value: "DEFAULT"
channel Mandatory	Enum Processing channel through which the card transaction happens Valid Values: PULSE VISA_DPS Sample Value :"VISA_DPS"
program Mandatory	String Name of the program to which the card product is mapped Sample Value : "DEFAULT"
card Mandatory	Object
cardId Mandatory	String Unique identifier of the card Sample Value : "ff32c9ded3774e109e002773e8822a0b"
countryGroupId Mandatory	String Unique identifier of the country group associated with the card Sample Value : "673d99a236e456cc9c792c14"
mccGroupId Mandatory	String Unique identifier of the MCC group associated with the card Sample Value : "673dacfe36e456cc9c7980d5"
lockCardAcceptor Optional	Enum Whether card is restricted to specific card acceptor or not, which is depending upon the given value Valid Values: DEFAULT – takes the value (YES or NO) given by admin YES – card is restricted to specific card acceptor NO – card is not restricted to specific card acceptor Sample Value : "NO"

Parameters

Description

reference

Optional

String

Unique reference ID of the request

Sample Value: "visadps100053"

transactionType

Mandatory

String

Type of operation / transaction

Constant Value : "UPDATE_CARD_GROUP"

customerId

Mandatory

String

Unique ID of the customer

Sample Value : "100000000006001"

accountNumber

Mandatory

String

Account number of the customer

Sample Value : "400320588344662"

product

Mandatory

String

Name of the product associated with the card

Sample Value: "DEFAULT"

channel

Mandatory

Enum

Processing channel through which the card transaction happens

Valid Values:

PULSE

VISA_DPS

Sample Value :"VISA_DPS"

program

Mandatory

String

Name of the program to which the card product is mapped

Sample Value : "DEFAULT"

card

Mandatory

Object

cardId

Mandatory

String

Unique identifier of the card

Sample Value : "ff32c9ded3774e109e002773e8822a0b"

countryGroupId

Mandatory

String

Unique identifier of the country group associated with the card

Sample Value : "673d99a236e456cc9c792c14"

mccGroupId

Mandatory

String

Unique identifier of the MCC group associated with the card

Sample Value : "673dacfe36e456cc9c7980d5"

lockCardAcceptor

Optional

Enum

Whether card is restricted to specific card

acceptor or not, which is depending upon the

given value

Valid Values:

DEFAULT – takes the value (YES or NO) given by

admin

YES – card is restricted to specific card acceptor

NO – card is not restricted to specific card

acceptor

Sample Value : "NO"

cURL
C#
Go
NodeJs

curl --location --globoff '{{URL}}/cardv2' \
--header 'Content-Type: application/json' \
--data '{"method":"ledger.CARD.request","id":"1","params":{"payload":{"reference":"visadps100053","transactionType":"UPDATE_CARD_GROUP","customerId":"100000000006001","accountNumber":"400320588344662","product":"DEFAULT","channel":"VISA_DPS","program":"DEFAULT","card":{"cardId":"ff32c9ded3774e109e002773e8822a0b","countryGroupId":"673d99a236e456cc9c792c14","mccGroupId":"673dacfe36e456cc9c7980d5","lockCardAcceptor":"NO"}},"api":{"credential":"{{cred}}","signature":"{{signature}}","apiKey":"{{Api-key}}"}}}'

var options = new RestClientOptions("{{URL}}/cardv2")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"    ""method"": ""ledger.CARD.request"",
" + "\n" +
@"    ""id"": ""1"",
" + "\n" +
@"    ""params"": {
" + "\n" +
@"        ""payload"": {
" + "\n" +
@"            ""reference"": ""visadps100053"",
" + "\n" +
@"            ""transactionType"": ""UPDATE_CARD_GROUP"",
" + "\n" +
@"            ""customerId"": ""100000000006001"",
" + "\n" +
@"            ""accountNumber"": ""400320588344662"",
" + "\n" +
@"            ""product"": ""DEFAULT"",
" + "\n" +
@"            ""channel"": ""VISA_DPS"",
" + "\n" +
@"            ""program"": ""DEFAULT"",
" + "\n" +
@"            ""card"": {
" + "\n" +
@"                ""cardId"": ""ff32c9ded3774e109e002773e8822a0b"",
" + "\n" +
@"                ""countryGroupId"": ""673d99a236e456cc9c792c14"",
" + "\n" +
@"                ""mccGroupId"": ""673dacfe36e456cc9c7980d5"",
" + "\n" +
@"                ""lockCardAcceptor"": ""NO""
" + "\n" +
@"            }
" + "\n" +
@"        },
" + "\n" +
@"        ""api"": {
" + "\n" +
@"            ""credential"": ""{{cred}}"",
" + "\n" +
@"            ""signature"": ""{{signature}}"",
" + "\n" +
@"            ""apiKey"": ""{{Api-key}}""
" + "\n" +
@"        }
" + "\n" +
@"    }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "{{URL}}/cardv2"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
    "method": "ledger.CARD.request",`+"
"+`
    "id": "1",`+"
"+`
    "params": {`+"
"+`
        "payload": {`+"
"+`
            "reference": "visadps100053",`+"
"+`
            "transactionType": "UPDATE_CARD_GROUP",`+"
"+`
            "customerId": "100000000006001",`+"
"+`
            "accountNumber": "400320588344662",`+"
"+`
            "product": "DEFAULT",`+"
"+`
            "channel": "VISA_DPS",`+"
"+`
            "program": "DEFAULT",`+"
"+`
            "card": {`+"
"+`
                "cardId": "ff32c9ded3774e109e002773e8822a0b",`+"
"+`
                "countryGroupId": "673d99a236e456cc9c792c14",`+"
"+`
                "mccGroupId": "673dacfe36e456cc9c7980d5",`+"
"+`
                "lockCardAcceptor": "NO"`+"
"+`
            }`+"
"+`
        },`+"
"+`
        "api": {`+"
"+`
            "credential": "{{cred}}",`+"
"+`
            "signature": "{{signature}}",`+"
"+`
            "apiKey": "{{Api-key}}"`+"
"+`
        }`+"
"+`
    }`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '{{URL}}',
  'path': '/cardv2',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "method": "ledger.CARD.request",
  "id": "1",
  "params": {
    "payload": {
      "reference": "visadps100053",
      "transactionType": "UPDATE_CARD_GROUP",
      "customerId": "100000000006001",
      "accountNumber": "400320588344662",
      "product": "DEFAULT",
      "channel": "VISA_DPS",
      "program": "DEFAULT",
      "card": {
        "cardId": "ff32c9ded3774e109e002773e8822a0b",
        "countryGroupId": "673d99a236e456cc9c792c14",
        "mccGroupId": "673dacfe36e456cc9c7980d5",
        "lockCardAcceptor": "NO"
      }
    },
    "api": {
      "credential": "{{cred}}",
      "signature": "{{signature}}",
      "apiKey": "{{Api-key}}"
    }
  }
});

req.write(postData);

req.end();

Body

{
    "method": "ledger.CARD.request",
    "id": "1",
    "params": {
        "payload": {
            "reference": "visadps100053",
            "transactionType": "UPDATE_CARD_GROUP",
            "customerId": "100000000006001",
            "accountNumber": "400320588344662",
            "product": "DEFAULT",
            "channel": "VISA_DPS",
            "program": "DEFAULT",
            "card": {
                "cardId": "ff32c9ded3774e109e002773e8822a0b",
                "countryGroupId": "673d99a236e456cc9c792c14",
                "mccGroupId": "673dacfe36e456cc9c7980d5",
                "lockCardAcceptor": "NO"
            }
        },
        "api": {
            "credential": "{{cred}}",
            "signature": "{{signature}}",
            "apiKey": "{{Api-key}}"
        }
    }
}

Response: 200

Response Parameters

Parameters	Description
Id	String Response Id echoed from the request Id Sample Value : "1"
result	Object
card	Object
cardId	String Unique identifier of the card Sample Value : "ff32c9ded3774e109e002773e8822a0b"
postedDate	String Date and time when the card details were posted Sample Value : "2024-11-20T07:32:53.796Z"
updatedDate	String Date and time when the card details were updated Sample Value : "2024-11-20T09:39:33.389Z"
allowAtm	Boolean Allowing card for transactions through ATM Sample Value : false
allowEcommerce	Boolean Allowing card for e-commerce transactions Sample Value : false
allowMoto	Boolean Allowing card for transactions through mobile Sample Value : false
allowPos	Boolean Allowing card for point-of-sale (POS) terminal transaction Sample Value : false
allowTips	Boolean Allowing card for tips transaction Sample Value : false
allowPurchase	Boolean Allowing card for purchase transaction Sample Value : false
allowRefund	Boolean Allowing card for refund transaction Sample Value : false
allowCashback	Boolean Allowing card for cashback transaction Sample Value : false
allowWithdraw	Boolean Allowing card for ATM withdrawal transaction Sample Value : false
allowAuthAndCompletion	Boolean Allowing for authorization and completion of transaction that happens through card Sample Value : false
smart	Boolean Allowing card for smart transaction Sample Value : false
checkAvsZip	Boolean Allowing card to perform AVS checks on the legalRep ZIP code during transaction Sample Value : false
checkAvsAddr	Boolean Allowing card to perform AVS checks on the legalRep address during transaction Sample Value : false
cvv	String Card Verification Value of the card Sample Value : ""
mccGroupId	String Unique identifier of the MCC group associated with the card Sample Value : "673dacfe36e456cc9c7980d5"
countryGroupId	String Unique identifier of the country group associated with the card Sample Value : "673d99a236e456cc9c792c14"
transactionMade	Boolean Indicates whether any transactions have been made using the card or not Sample Value : false
isReIssue	Boolean Indicates whether the card is reissued Sample Value : false
isReplace	Boolean Indicates whether the card replaced Sample Value : false
api	Object
type	String Acknowledgement for type of operation requested for Constant value: " UPDATE_CARD_GROUP_ACK"
reference	String Auto generated reference ID of this acknowledgment Sample value: " REFvisadps100053"
dateCreated	Number Unix timestamp of the response was created Sample value: 1732095573
originalReference	String Original reference ID taken from the request Sample value: " visadps100053"

{
  "id": "1",
  "result": {
    "card": {
      "cardId": "ff32c9ded3774e109e002773e8822a0b",
      "postedDate": "2024-11-20T07:32:53.796Z",
      "updatedDate": "2024-11-20T09:39:33.389Z",
      "allowAtm": false,
      "allowEcommerce": false,
      "allowMoto": false,
      "allowPos": false,
      "allowTips": false,
      "allowPurchase": false,
      "allowRefund": false,
      "allowCashback": false,
      "allowWithdraw": false,
      "allowAuthAndCompletion": false,
      "smart": false,
      "checkAvsZip": false,
      "checkAvsAddr": false,
      "cvv": "",
      "mccGroupId": "673dacfe36e456cc9c7980d5",
      "countryGroupId": "673d99a236e456cc9c792c14",
      "transactionMade": false,
      "isReIssue": false,
      "isReplace": false
    },
    "api": {
      "type": "UPDATE_CARD_GROUP_ACK",
      "reference": "REFvisadps100053",
      "dateCreated": 1732095573,
      "originalReference": "visadps100053"
    }
  }
}

Add or Update Card Group

Method: POST​

Headers​

Example​

Body​

Response: 200​

Method: POST

Headers

Example

Body

Response: 200